GAO Ballot Package

This page is part of the FHIR Specification (v1.1.0: STU 3 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

This is a frozen snapshot of the FHIR specification created for the purpose of balloting the GAO implementation Guide. It includes draft changes that may be part of the future DSTU 2.1 release but further change is expected. Readers should focus solely on the GAO implementation content, and FHIR DSTU 2 for other purposes.

Extension: parameter

URL for this extension:

http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter

Status: draft. Extension maintained by: Health Level Seven, Inc. - CDS WG

Parameters to the module.

Context of Use: Use on element: Basic

usage info: insert a list of places where this extension is used

Summary

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter parameter: Parameters to the module. Use on element: Basic
name	1..1	code	The name of the parameter.
use	1..1	code	Whether the parameter is input or output for the module.
documentation	0..1	string	A brief description of the parameter.
type	1..1	code	The type of the parameter.
profile	0..1	Reference(StructureDefinition)	The profile of the parameter, if any.
Documentation for this format

Fulle Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter parameter: Parameters to the module. Use on element: Basic
extension	1..1	Extension	Extension
extension	0..0
url	1..1	uri	"name"
valueCode	1..1	code	Value of extension
extension	1..1	Extension	Extension
extension	0..0
url	1..1	uri	"use"
valueCode	1..1	code	Value of extension Binding: OperationParameterUse (required)
extension	0..1	Extension	Extension
extension	0..0
url	1..1	uri	"documentation"
valueString	1..1	string	Value of extension
extension	1..1	Extension	Extension
extension	0..0
url	1..1	uri	"type"
valueCode	1..1	code	Value of extension Binding: Parameter Types used in Operation Definitions (required)
extension	0..1	Extension	Extension
extension	0..0
url	1..1	uri	"profile"
valueReference	1..1	Reference(StructureDefinition)	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter"
value[x]	0..0
Documentation for this format

XML Template

<!-- parameter -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="name"> 1..1 Extension  <!-- 1..1 Extension -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="use"> 1..1 Extension  <!-- 1..1 Extension -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="documentation"> 0..1 Extension  <!-- 0..1 Extension -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="type"> 1..1 Extension  <!-- 1..1 Extension -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="profile"> 0..1 Extension  <!-- 0..1 Extension -->
  <valueReference><!-- 1..1 Reference(StructureDefinition) 
      Value of extension --></valueReference>
 </extension>
</extension>

JSON Template

{ // parameter
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Extension // R! 
        // from Element: extension
        "url" : "name", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // Extension // R! 
        // from Element: extension
        "url" : "use", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // Extension //
        // from Element: extension
        "url" : "documentation", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // Extension // R! 
        // from Element: extension
        "url" : "type", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // Extension //
        // from Element: extension
        "url" : "profile", // R! 
        "valueReference" : { Reference(StructureDefinition) } // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter", // R! 
// value[x]: Value of extension. One of these 33:
  }

Summary

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter parameter: Parameters to the module. Use on element: Basic
name	1..1	code	The name of the parameter.
use	1..1	code	Whether the parameter is input or output for the module.
documentation	0..1	string	A brief description of the parameter.
type	1..1	code	The type of the parameter.
profile	0..1	Reference(StructureDefinition)	The profile of the parameter, if any.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter parameter: Parameters to the module. Use on element: Basic
extension	1..1	Extension	Extension
extension	0..0
url	1..1	uri	"name"
valueCode	1..1	code	Value of extension
extension	1..1	Extension	Extension
extension	0..0
url	1..1	uri	"use"
valueCode	1..1	code	Value of extension Binding: OperationParameterUse (required)
extension	0..1	Extension	Extension
extension	0..0
url	1..1	uri	"documentation"
valueString	1..1	string	Value of extension
extension	1..1	Extension	Extension
extension	0..0
url	1..1	uri	"type"
valueCode	1..1	code	Value of extension Binding: Parameter Types used in Operation Definitions (required)
extension	0..1	Extension	Extension
extension	0..0
url	1..1	uri	"profile"
valueReference	1..1	Reference(StructureDefinition)	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter"
value[x]	0..0
Documentation for this format

XML Template

<!-- parameter -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="name"> 1..1 Extension  <!-- 1..1 Extension -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="use"> 1..1 Extension  <!-- 1..1 Extension -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="documentation"> 0..1 Extension  <!-- 0..1 Extension -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="type"> 1..1 Extension  <!-- 1..1 Extension -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="profile"> 0..1 Extension  <!-- 0..1 Extension -->
  <valueReference><!-- 1..1 Reference(StructureDefinition) 
      Value of extension --></valueReference>
 </extension>
</extension>

JSON Template

{ // parameter
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Extension // R! 
        // from Element: extension
        "url" : "name", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // Extension // R! 
        // from Element: extension
        "url" : "use", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // Extension //
        // from Element: extension
        "url" : "documentation", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // Extension // R! 
        // from Element: extension
        "url" : "type", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // Extension //
        // from Element: extension
        "url" : "profile", // R! 
        "valueReference" : { Reference(StructureDefinition) } // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqif-basic-parameter", // R! 
// value[x]: Value of extension. One of these 33:
  }